/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/10
 * Time: 12:54
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.social.model.tagging;

import kiwi.core.model.Constants;
import kiwi.core.model.annotations.RDF;
import kiwi.core.model.annotations.RDFInverse;
import kiwi.core.model.annotations.RDFType;
import kiwi.core.model.entity.KiWiFacade;
import kiwi.core.model.rdf.KiWiResource;

import java.util.Set;

/**
 * A tag is a KiWi resource that is used to tagged other KiWi resources. A tag participates in Taggings.
 * <p/>
 * User: sschaffe
 */
@RDFType({Constants.NS_HGTAGS+"Tag", Constants.NS_MOAT+"Tag" })
public interface Tag extends KiWiFacade {

    /**
     * Return the tag labels that are used to refer to this tag in addition to the title.
     * @return
     */
    @RDF(Constants.NS_HGTAGS+"name")
    public Set<String> getTagLabels();



    /**
     * Return the tag labels that are used to refer to this tag in addition to the title.
     * @return
     */
    public void setTagLabels(Set<String> labels);



    /**
     * Return a collection of the items tagged with the tag.
     * @return
     */
    @RDF(Constants.NS_HGTAGS+"isTagOf")
    public Set<KiWiResource> getTaggedItems();


    /**
     * Return a collection of tags that are equivalent to the tag.
     * @return
     */
    @RDF(Constants.NS_HGTAGS+"equivalentTag")
    public Set<Tag> getEquivalentTags();


    /**
     * Set the tags that are equivalent to the tag.
     * @param equivalentTags
     */
    public void setEquivalentTags(Set<Tag> equivalentTags);


    /**
     * Return the taggings that use this tag.
     * @return
     */
    @RDFInverse(Constants.NS_HGTAGS+"associatedTag")
    public Set<Tagging> getTaggings();
}
